Skip to content

docs: update README for documents table (91 → 95 tables)#36

Merged
pyramation merged 1 commit intomainfrom
feat/update-readme-documents
Apr 30, 2026
Merged

docs: update README for documents table (91 → 95 tables)#36
pyramation merged 1 commit intomainfrom
feat/update-readme-documents

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

Summary

Updates the README to reflect the new documents table added in #34/#35. Changes:

  • Table counts: 91 → 95 everywhere (SDK, CLI, deploy command, packages table, skills table)
  • "What an agent actually needs" table: new Documents / CMS row
  • Architecture diagram: added documents (chunked) line
  • Memory section: added document junctions, updated chunked search references
  • World model section: new Documents / CMS entry with full column list
  • Junction count: ~25 → ~27
  • Sample query: added "Find all documents from the biz-docs repo tagged 'pitch'"
  • Auto-embed section: documents now mentioned alongside contacts and notes

Review & Testing Checklist for Human

  • Skim the README and confirm the documents sections read naturally alongside existing content

Notes

Pure documentation change — no code affected.

Link to Devin session: https://app.devin.ai/sessions/2a4faca18f1a4b4aaf3d8e1162f67e0d
Requested by: @pyramation

- Add Documents / CMS row to 'What an agent actually needs' table
- Add documents to architecture diagram
- Add documents to Memory section (junctions, chunked search)
- Add Documents / CMS entry to World model section
- Update junction count (~25 → ~27)
- Update table counts: 91 → 95 everywhere
- Add sample query for documents
- Mention documents in chunked retrieval and auto-embed sections
@devin-ai-integration
Copy link
Copy Markdown

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit e92daa9 into main Apr 30, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant